package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.SalaryTableAddDTO;
import org.jsola.hr.dto.SalaryTableUpdateDTO;
import org.jsola.hr.query.SalaryTableExportQuery;
import org.jsola.hr.query.SalaryTableQuery;
import org.jsola.hr.vo.SalaryTableListVO;
import org.jsola.hr.vo.SalaryTableVO;
import org.springframework.core.io.Resource;
import org.springframework.http.ResponseEntity;

import javax.validation.Valid;
import java.util.List;
import java.util.Map;

/**
 * 工资表（工资条统计）
 *
 * @author zhr
 */
@Api(tags = "hr-工资表（工资条统计）")
public interface ISalaryTableControllerAPI {

    /**
     * 新增工资表（工资条统计）
     * @param salaryTableAddDTO 工资表（工资条统计）新增实体
     * @return 工资表（工资条统计）展示对象
     */
    @ApiOperation(value = "新增工资表（工资条统计）")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryTableAddDTO", dataType = "SalaryTableAddDTO", value = "新增工资表（工资条统计）", paramType = "body")
    })
    Result<SalaryTableVO> save(SalaryTableAddDTO salaryTableAddDTO);


    /**
     * 修改工资表（工资条统计）
     * @param salaryTableUpdateDTO 工资表（工资条统计）
     * @return 更新数量
     */
    @ApiOperation(value = "修改工资表（工资条统计）")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryTableUpdateDTO", dataType = "SalaryTableUpdateDTO", value = "修改工资表（工资条统计）", paramType = "body")
    })
    Result<Integer> update(SalaryTableUpdateDTO salaryTableUpdateDTO);




    /**
     * 删除单个工资表（工资条统计），彻底删除
     * @param salaryTableId 工资表（工资条统计）id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个工资表（工资条统计），彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryTableId", dataType = "String", value = "工资表（工资条统计）id", paramType = "path")
    })
    Result<Integer> delete(String salaryTableId);


    /**
     * 批量删除工资表（工资条统计），彻底删除
     * @param salaryTableIds 工资表（工资条统计）id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除工资表（工资条统计），彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryTableIds", dataType = "String[]", value = "工资表（工资条统计）id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] salaryTableIds);


    /**
     * 根据工资表（工资条统计）id查询工资表（工资条统计）详情
     * @param salaryTableId 工资表（工资条统计）id
     * @return 工资表（工资条统计）详情
     */
    @ApiOperation(value="根据工资表（工资条统计）id查询工资表（工资条统计）详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryTableId", dataType = "String", value = "工资表（工资条统计）id", paramType = "path")
    })
    Result<SalaryTableVO> findById(String salaryTableId);


    /**
     * 查询工资表（工资条统计）
     * @param salaryTableQuery 工资表（工资条统计）查询参数
     * @return page
     */
    @ApiOperation(value="查询工资表（工资条统计）")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryTableQuery", dataType = "SalaryTableQuery", value = "工资表（工资条统计）查询参数", paramType = "query")
    })
    Result<List<SalaryTableListVO>> listAll(SalaryTableQuery salaryTableQuery);


     /**
     * 分页查询工资表（工资条统计）
     * @param salaryTableQuery 工资表（工资条统计）查询参数
     * @return page
     */
    @ApiOperation(value="分页查询工资表（工资条统计）")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryTableQuery", dataType = "SalaryTableQuery", value = "工资表（工资条统计）查询参数", paramType = "query")
    })
    Result<Page<SalaryTableListVO>> page(SalaryTableQuery salaryTableQuery);


    /**
     * 查询工资表（工资条统计）相关
     * @param salaryTableQuery 工资表（工资条统计）查询参数
     * @return page
     */
    @ApiOperation(value="按年查询工资表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryTableQuery", dataType = "SalaryTableQuery", value = "工资表（工资条统计）查询参数", paramType = "query")
    })
    Result<Map<String, List<SalaryTableListVO>>> listAllRelation(SalaryTableQuery salaryTableQuery);


    /**
     * 查询已导入工资表的年份列表
     * @param salaryTableQuery 工资表（工资条统计）查询参数
     * @return page
     */
    @ApiOperation(value="查询已导入工资表的年份列表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryTableQuery", dataType = "SalaryTableQuery", value = "工资表（工资条统计）查询参数", paramType = "query")
    })
    Result<List<String>> salaryTableImportedYearList(SalaryTableQuery salaryTableQuery);


    /**
     * 查询员工工资表年月分组
     * @param salaryTableQuery 工资表（工资条统计）查询参数
     * @return list
     */
    @ApiOperation(value="查询员工工资表年月分组")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryTableQuery", dataType = "SalaryTableQuery", value = "工资表（工资条统计）查询参数", paramType = "query")
    })
    Result<List<SalaryTableListVO>> salaryTableGroupByEmpId(SalaryTableQuery salaryTableQuery);


    /**
     * 查询员工工资表年月分组相关
     * @param salaryTableQuery 工资表（工资条统计）查询参数
     * @return list
     */
    @ApiOperation(value="查询员工工资表年月分组相关")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryTableQuery", dataType = "SalaryTableQuery", value = "工资表（工资条统计）查询参数", paramType = "query")
    })
    Result<List<SalaryTableListVO>> salaryTableGroupByMonthEmpId(SalaryTableQuery salaryTableQuery);

    /**
     * 电子工资条导出
     * @param salaryTableExportQuery 导出参数
     * @return Excel
     */
    @ApiOperation(value="电子工资条导出")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryTableExportQuery", dataType = "SalaryTableExportQuery", value = "导出参数", paramType = "body")
    })
    ResponseEntity<Resource> salaryTableExport(SalaryTableExportQuery salaryTableExportQuery);


}

